home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / perldoc.z / perldoc
Text File  |  1998-10-30  |  4KB  |  133 lines
  1.  
  2.  
  3.  
  4. PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))                                                          PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      perldoc - Look up Perl documentation in pod format.
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ppppeeeerrrrllllddddoooocccc [----hhhh] [----vvvv] [----tttt] [----uuuu] [----mmmm] [----llll] PageName|ModuleName|ProgramName
  13.  
  14.      ppppeeeerrrrllllddddoooocccc ----ffff BuiltinFunction
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      _p_e_r_l_d_o_c looks up a piece of documentation in .pod format that is embedded
  18.      in the perl installation tree or in a perl script, and displays it via
  19.      pod2man | nroff -man | $PAGER. (In addition, if running under HP-UX, col
  20.      -x will be used.) This is primarily used for the documentation for the
  21.      perl library modules.
  22.  
  23.      Your system may also have man pages installed for those modules, in which
  24.      case you can probably just use the _m_a_n(1) command.
  25.  
  26. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  27.      ----hhhh help
  28.           Prints out a brief help message.
  29.  
  30.      ----vvvv verbose
  31.           Describes search for the item in detail.
  32.  
  33.      ----tttt text output
  34.           Display docs using plain text converter, instead of nroff. This may
  35.           be faster, but it won't look as nice.
  36.  
  37.      ----uuuu unformatted
  38.           Find docs only; skip reformatting by pod2*
  39.  
  40.      ----mmmm module
  41.           Display the entire module: both code and unformatted pod
  42.           documentation.  This may be useful if the docs don't explain a
  43.           function in the detail you need, and you'd like to inspect the code
  44.           directly; perldoc will find the file for you and simply hand it off
  45.           for display.
  46.  
  47.      ----llll file name only
  48.           Display the file name of the module found.
  49.  
  50.      ----ffff perlfunc
  51.           The ----ffff option followed by the name of a perl built in function will
  52.           extract the documentation of this function from the _p_e_r_l_f_u_n_c
  53.           manpage.
  54.  
  55.      PPPPaaaaggggeeeeNNNNaaaammmmeeee||||MMMMoooodddduuuulllleeeeNNNNaaaammmmeeee||||PPPPrrrrooooggggrrrraaaammmmNNNNaaaammmmeeee
  56.           The item you want to look up.  Nested modules (such as
  57.           File::Basename) are specified either as File::Basename or
  58.           File/Basename.  You may also give a descriptive name of a page, such
  59.           as perlfunc. You make also give a partial or wrong-case name, such
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))                                                          PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))
  71.  
  72.  
  73.  
  74.           as "basename" for "File::Basename", but this will be slower, if
  75.           there is more then one page with the same partial name, you will
  76.           only get the first one.
  77.  
  78. EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
  79.      Any switches in the PERLDOC environment variable will be used before the
  80.      command line arguments.  perldoc also searches directories specified by
  81.      the PERL5LIB (or PERLLIB if PERL5LIB is not defined) and PATH environment
  82.      variables.  (The latter is so that embedded pods for executables, such as
  83.      perldoc itself, are available.)
  84.  
  85. AAAAUUUUTTTTHHHHOOOORRRR
  86.      Kenneth Albanowski <kjahds@kjahds.com>
  87.  
  88.      Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.